package cn.tedu.tea.admin.server.content.service;

import cn.tedu.tea.admin.server.common.pojo.vo.PageData;
import cn.tedu.tea.admin.server.content.pojo.param.CommentAddNewParam;
import cn.tedu.tea.admin.server.content.pojo.vo.CommentListItemVO;
import org.springframework.transaction.annotation.Transactional;

/**
 * 处理评论数据的业务接口
 *
 * @author java@tedu.cn
 * @version 1.0
 */
@Transactional
public interface ICommentService {

    /**
     * 评论“是否启用”的状态文本
     */
    String[] CHECK_TEXT = {"不通过", "通过"};
    /**
     * 评论“是否显示”的状态文本
     */
    String[] DISPLAY_TEXT = {"隐藏", "显示"};

    /**
     * 新增评论
     *
     * @param commentAddNewParam 新增的评论数据
     */
    void addNew(CommentAddNewParam commentAddNewParam);

    /**
     * 审核通过评论
     *
     * @param id 尝试审核通过的评论的ID
     */
    void passCheck(Long id);

    /**
     * 取消审核通过评论
     *
     * @param id 尝试取消审核的评论的ID
     */
    void cancelCheck(Long id);

    /**
     * 显示评论
     *
     * @param id 尝试显示的评论的ID
     */
    void setDisplay(Long id);

    /**
     * 隐藏（不显示）评论
     *
     * @param id 尝试隐藏的评论的ID
     */
    void setHidden(Long id);

    /**
     * 查询评论列表，将使用默认的每页记录数
     *
     * @param pageNum 页码
     * @return 文章列表
     */
    PageData<CommentListItemVO> list(Integer pageNum);

    /**
     * 查询评论数据列表
     *
     * @param pageNum  页码
     * @param pageSize 每页记录数
     * @return 评论数据列表
     */
    PageData<CommentListItemVO> list(Integer pageNum, Integer pageSize);

    /**
     * 根据文章查询评论列表，将使用默认的每页记录数
     *
     * @param articleId 文章ID
     * @param pageNum   页码
     * @return 评论列表
     */
    PageData<CommentListItemVO> listByArticleId(Long articleId, Integer pageNum);

    /**
     * 根据文章查询评论列表
     *
     * @param articleId 文章ID
     * @param pageNum   页码
     * @param pageSize  每页记录数
     * @return 评论列表
     */
    PageData<CommentListItemVO> listByArticleId(Long articleId, Integer pageNum, Integer pageSize);

}
